@zilliqa-js/blockchain
Advanced tools
Classes for high-level interaction with the Zilliqa blockchain.
export interface BlockchainInfo {
NumPeers: number;
NumTxBlocks: string;
NumDSBlocks: string;
NumTransactions: string;
TransactionRate: number;
TxBlockRate: number;
DSBlockRate: number;
CurrentMiniEpoch: string;
CurrentDSEpoch: string;
NumTxnsDSEpoch: string;
NumTxnsTxEpoch: number;
ShardingStructure: ShardingStructure;
}
export interface ShardingStructure {
NumPeers: number[];
}
export interface TransactionObj {
ID: string;
version: string;
nonce: number;
toAddr: string;
amount: string;
gasPrice: string;
gasLimit: string;
signature: string;
receipt: TransactionReceiptObj;
}
export interface DsBlockHeader {
blockNum: string;
difficulty: number;
leaderPubKey: string;
minerPubKey: string;
nonce: string;
prevhash: string;
// unix epoch
timestamp: string;
}
export interface DsBlockObj {
header: DsBlockHeader;
signature: string;
}
interface BlockShort {
BlockNum: number;
Hash: string;
}
export interface BlockList {
data: BlockShort[];
maxPages: number;
}
const enum TxBlockType {
MICRO,
FINAL,
}
export interface TxBlockHeader {
Type: TxBlockType;
Version: number;
GasLimit: string;
GasUsed: string;
Rewards: string;
PrevBlockHash: string;
BlockNum: string;
Timestamp: string;
TxnHash: string;
StateHash: string;
NumTxns: number;
NumMicroBlocks: number;
MinerPubKey: string;
DSBlockNum: string;
}
export interface TxBlockObj {
body: {
HeaderSign: string;
MicroBlockEmpty: number[];
MicroBlockHashes: string[];
};
header: TxBlockHeader;
}
export interface TxList {
number: number;
TxnHashes: string[];
}
export interface TransactionReceiptObj {
success: boolean;
cumulative_gas: string;
event_logs: EventLogEntry[];
}
export interface EventLogEntry {
address: string;
_eventname: string;
params: EventParam[];
}
export interface EventParam {
vname: string;
type: string;
value: string;
}
BlockchainClass that wraps http requests for blockchain-related RPC calls.
Blockchain(provider: Provider, signer: Wallet): BlockchainParameters
provider: Providersigner: WalletReturns
Blockchainprovider: Providersigner: WalletgetBlockChainInfo(): Promise<RPCResponse<ShardingStructure, string>>Retrieves generally blockchain information, such as the number of nodes per shard.
Parameters
None
Returns
Promise<RPCResponse<ShardingStructure, string>>getDSBlock(blockNum: number): Promise<RPCResponse<DsBlockObj, string>>Queries the blockchain for a specific DS block, by number.
Parameters
blockNum: string - the DS block the retrieveReturns
Promise<RPCResponse<DsBlockObj, string>>getLatestDSBlock(): Promise<RPCResponse<DsBlockObj, string>>Gets the most recently confirmed DS block.
Parameters
None
Returns
Promise<RPCResponse<DsBlockObj, string>>getNumDSBlocks(): Promise<RPCResponse<string, string>>Queries the blockchain for the number of confirmed DS blocks in the chain.
Parameters
None
Returns
Promise<RPCResponse<string, string>> - use parseInt as the number is encoded as a string.getDSBlockRate(): Promise<RPCResponse<number, string>>Gets the ds blocks processed per second.
Parameters
None
Returns
Promise<RPCResponse<number, string>>getDSBlockListing(max: number): Promise<RPCResponse<BlockList, string>>Gets a paginated list of DS blocks.
Parameters
max: number - the maximum number of pages to retrieve
Returns
Promise<RPCResponse<BlockList, string>>getTxBlock(blockNum: number): Promise<RPCResponse<TxBlockObj, string>>Retrieves a TxBlock by number.
Parameters
blockNum: number - the tx block to retrieve.
Returns
Promise<RPCResponse<TxBlockObj, string>>getLatestTxBlock(): Promise<RPCResponse<TxBlockObj, string>>Gets the most recently confirmed Tx block.
Parameters
None
Returns
Promise<RPCResponse<DsBlockObj, string>>getNumTxBlocks(): Promise<RPCResponse<string, string>>Queries the blockchain for the number of confirmed Tx blocks in the chain.
Parameters
None
Returns
Promise<RPCResponse<string, string>> - use parseInt as the number is encoded as a string.getTxBlockRate(): Promise<RPCResponse<number, string>>Gets the Tx blocks processed per second.
Parameters
None
Returns
Promise<RPCResponse<number, string>>getTxBlockListing(max: number): Promise<RPCResponse<BlockList, string>>Gets a paginated list of Tx blocks.
Parameters
max: number - the maximum number of pages to retrieve
Returns
Promise<RPCResponse<BlockList, string>>FAQs
Class(es) for interacting with the Zilliqa blockchain.
The npm package @zilliqa-js/blockchain receives a total of 504 weekly downloads. As such, @zilliqa-js/blockchain popularity was classified as not popular.
We found that @zilliqa-js/blockchain demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."